IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il_c/ilMpNode.z/ilMpNode

Text File | 2002-10-03 | 7.9 KB | 199 lines

iiiillllMMMMppppNNNNooooddddeeee((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllMMMMppppNNNNooooddddeeee((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllMMMMppppNNNNooooddddeeee - base class for MP dependency graph

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     This is a base class

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilCdefs.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     ilMpNode is the base class defining a dependency graph for parallel
     processing.  ilMpManager and ilMpRequest are both derived from this
     class.  Those classes provide a generalized method to execute work in
     parallel using a configurable number of threads created with sssspppprrrroooocccc().

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     SSSSttttaaaattttuuuussss mmmmeeeetttthhhhooooddddssss

          ilStatus ilMpNodeGetStatus(ilMpNode *obj)

     OOOOtttthhhheeeerrrr mmmmeeeemmmmbbbbeeeerrrr qqqquuuueeeerrrriiiieeeessss

          int ilMpNodeGetDepth(ilMpNode *obj)
          ilMpState ilMpNodeGetState(ilMpNode *obj)
          ilMpNode* ilMpNodeGetParent(ilMpNode *obj)

     TTTTiiiimmmmiiiinnnngggg qqqquuuueeeerrrriiiieeeessss

          float ilMpNodeGetProcessingTime(ilMpNode *obj)
          void ilMpNodeAddProcessingTime(ilMpNode *obj, float selfDelta,
                                         float parentDelta)
          float ilMpNodeGetTimingWeight(ilMpNode *obj)
          void ilMpNodeSetTimingWeight(ilMpNode *obj, float weight)

     AAAAbbbboooorrrrtttt ccccoooonnnnttttrrrroooollll

          int ilMpNodeIsAborting(ilMpManager *obj)
          int ilMpNodeInhibitAbort(ilMpManager *obj)


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     aaaaddddddddPPPPrrrroooocccceeeessssssssiiiinnnnggggTTTTiiiimmmmeeee(((())))

          void ilMpNodeAddProcessingTime(ilMpNode *obj, float selfDelta,
                                         float parentDelta)


          This method accumulates more processing time for this node and
          optionally our parent (time can be shifted from self to parent by
          specifying _s_e_l_f_D_e_l_t_a = -_p_a_r_e_n_t_D_e_l_t_a).





                                                                        PPPPaaaaggggeeee 1111






iiiillllMMMMppppNNNNooooddddeeee((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllMMMMppppNNNNooooddddeeee((((3333))))



     ggggeeeettttDDDDeeeepppptttthhhh(((())))

          int ilMpNodeGetDepth(ilMpNode *obj)


          This method returns the distance from the top of the node hierarchy
          for this node, only requests are counted in the depth; managers are
          effectively invisible. The depth is used to encourage depth first
          building of the dependency graph.

     ggggeeeettttPPPPaaaarrrreeeennnntttt(((())))

          ilMpNode* ilMpNodeGetParent(ilMpNode *obj)


          This method returns the parent for this node; ilMpRequest's always
          have ilMpManager's as parents, ilMpManager's can have either type of
          ilMpNode as parents.

     ggggeeeettttPPPPrrrroooocccceeeessssssssiiiinnnnggggTTTTiiiimmmmeeee(((())))

          float ilMpNodeGetProcessingTime(ilMpNode *obj)


          This method returns the inclusive time to process this node and it's
          children; for requests this includes read/compute/graphics process
          times but not prepare/finish, for managers this includes the
          completion callback time.

     ggggeeeettttSSSSttttaaaatttteeee(((())))

          ilMpState ilMpNodeGetState(ilMpNode *obj)


          This method returns the current "state" for this node, possible
          states are:

          _i_l_M_p_I_n_i_t        under construction

          _i_l_M_p_P_r_e_p        just constructed, waiting to be prepared

          _i_l_M_p_W_a_i_t        waiting for dependents to complete

          _i_l_M_p_R_e_a_d        waiting to read input data

          _i_l_M_p_G_r_a_p_h_i_c_s    ready to be rendered

          _i_l_M_p_C_o_m_p_u_t_e     ready to be computed

          _i_l_M_p_P_a_r_k_e_d      waiting on another request doing our work for us





                                                                        PPPPaaaaggggeeee 2222






iiiillllMMMMppppNNNNooooddddeeee((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllMMMMppppNNNNooooddddeeee((((3333))))



          _i_l_M_p_F_i_n_i_s_h      ready to do finish processing

          _i_l_M_p_D_o_n_e        delete the request.

     ggggeeeettttSSSSttttaaaattttuuuussss(((())))

          ilStatus ilMpNodeGetStatus(ilMpNode *obj)


          Returns the current status of this node.

     ggggeeeettttTTTTiiiimmmmiiiinnnnggggWWWWeeeeiiiigggghhhhtttt(((())))

          float ilMpNodeGetTimingWeight(ilMpNode *obj)


          This method returns the weighting to apply to this node's processing
          time when summing it into the parent node (default weight is 1).

     iiiinnnnhhhhiiiibbbbiiiittttAAAAbbbboooorrrrtttt(((())))

          int ilMpNodeInhibitAbort(ilMpManager *obj)


          This method prevents this node and all of its dependents from being
          aborted when the aaaabbbboooorrrrtttt() method is called on a top level manager
          that has this node as a direct or indirect dependent.

     iiiissssAAAAbbbboooorrrrttttiiiinnnngggg(((())))

          int ilMpNodeIsAborting(ilMpManager *obj)


          This method returns true if this node is in the process of aborting.
          Requests may want to check this periodically during long operations
          to avoid wasted work.

     sssseeeettttTTTTiiiimmmmiiiinnnnggggWWWWeeeeiiiigggghhhhtttt(((())))

          void ilMpNodeSetTimingWeight(ilMpNode *obj, float weight)


          This method sets the weighting to apply to this node's processing
          time when summing it into the parent node (default weight is 1).

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     ilMpManager(3), ilMpRequest(3)








                                                                        PPPPaaaaggggeeee 3333